Retrieve a list of descendant group IDs

Retrieve a list of descendant group IDs for the specified group and depth.

SecuritybearerAuth
Request
path Parameters
groupIdentifier
required
string

ID of the group to retrieve group descendant IDs for.

Example: 880e60d8-fbed-217a-1720-6511d9f16361
query Parameters
depth
integer

Number of levels of group descendants returned.

  • depth = NULL: Returns children group IDs directly under the specified group.
  • depth = 0: Returns group IDs of all groups within hierarchy.
  • depth = 1: Returns children group IDs directly under the specified group.
  • depth = 2: Returns children and grandchildren group IDs for the specified group.
  • depth > maximum levels in hierarchy: Returns descendant group IDs at all depths for the specified group.
Example: depth=2
Responses
200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Resource Not Found

500

Internal Server Error

get/groups/{groupIdentifier}/descendants
Request samples
Response samples
application/json
[
  • "880e60d8-fbed-217a-1720-6511d9f16361",
  • "880e60d8-fbed-217b-1720-6511d9f16361",
  • "880e60d8-fbed-217c-1720-6511d9f16361"
]